Spread ASP.NET 6.0 Product Documentation
SortColumns(Int32,Int32,SortInfo[]) Method
See Also Example Send Feedback

FarPoint.Web.Spread Assembly > FarPoint.Web.Spread Namespace > SheetView Class > SortColumns Method : SortColumns(Int32,Int32,SortInfo[]) Method

Visual Basic (Declaration)
Visual Basic (Usage)
C#

column: Starting column index (the start of the range of columns to sort)

columnCount: Number of columns in the range to sort

sortInfo: Array of SortInfo objects containing the row indexes and the order of sorting

Sorts a range of columns in the sheet according to the specified parameters.

Syntax

Visual Basic (Declaration)
Public Overloads Function SortColumns( _ ByVal column As Integer, _ ByVal columnCount As Integer, _ ByVal sortInfo() As SortInfo _ ) As Boolean

Visual Basic (Usage)	Copy Code
Dim instance As SheetView Dim column As Integer Dim columnCount As Integer Dim sortInfo() As SortInfo Dim value As Boolean value = instance.SortColumns(column, columnCount, sortInfo)

C#
public bool SortColumns( int column, int columnCount, SortInfo[] sortInfo )

Parameters

column: Starting column index (the start of the range of columns to sort)
columnCount: Number of columns in the range to sort
sortInfo: Array of SortInfo objects containing the row indexes and the order of sorting

Return Value

true if successful; otherwise false

Remarks

Use this method if you want to sort only a range of columns and not the entire sheet.

Use this method if you want to specify more than one row by which to sort. In other words, if you have more than one key for sorting. The SortInfo array can contain multiple keys (multiple rows) and the first specified row is the primary key, etc. The SortInfo array can also contain a value for IComparer to allow you to specify the way of comparing that is used in the sort and it may be different for each key.

Example

This example illustrates the use of this member by sorting the columns with the specified parameters.

C#	Copy Code
FarPoint.Web.Spread.SheetView sv; FarPoint.Web.Spread.SortInfo[] s = new FarPoint.Web.Spread.SortInfo[1]; s[0] = new FarPoint.Web.Spread.SortInfo(0, false); sv = FpSpread1.ActiveSheetView; sv.SortColumns(0, 2, s);

Copy Code

FarPoint.Web.Spread.SheetView sv;
FarPoint.Web.Spread.SortInfo[] s = new FarPoint.Web.Spread.SortInfo[1];
s[0] = new FarPoint.Web.Spread.SortInfo(0, false);
sv = FpSpread1.ActiveSheetView;
sv.SortColumns(0, 2, s);

Visual Basic	Copy Code
Dim sv As FarPoint.Web.Spread.SheetView Dim s(1) As FarPoint.Web.Spread.SortInfo s(0) = New FarPoint.Web.Spread.SortInfo(0, False) sv = FpSpread1.ActiveSheetView sv.SortColumns(0, 2, s)

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family